org.springframework.web.reactive.resource

Class WebJarsResourceResolver

java.lang.Object

org.springframework.web.reactive.resource.AbstractResourceResolver

org.springframework.web.reactive.resource.WebJarsResourceResolver

All Implemented Interfaces:

ResourceResolver

public class WebJarsResourceResolver
extends AbstractResourceResolver

A ResourceResolver that delegates to the chain to locate a resource and then attempts to find a matching versioned resource contained in a WebJar JAR file.

This allows WebJars.org users to write version agnostic paths in their templates, like <script src="/jquery/jquery.min.js"/>. This path will be resolved to the unique version <script src="/jquery/1.2.0/jquery.min.js"/>, which is a better fit for HTTP caching and version management in applications.

This also resolves resources for version agnostic HTTP requests "GET /jquery/jquery.min.js".

This resolver requires the "org.webjars:webjars-locator" library on classpath, and is automatically registered if that library is present.

Since:

5.0

Author:

Rossen Stoyanchev, Brian Clozel

See Also:

webjars.org

Field Summary

Fields

Modifier and Type	Field and Description
private WebJarAssetLocator	webJarAssetLocator
private static java.lang.String	WEBJARS_LOCATION
private static int	WEBJARS_LOCATION_LENGTH

Fields inherited from class org.springframework.web.reactive.resource.AbstractResourceResolver

logger

Constructor Summary

Constructors

Constructor and Description
WebJarsResourceResolver() Create a WebJarsResourceResolver with a default WebJarAssetLocator instance.
WebJarsResourceResolver(WebJarAssetLocator webJarAssetLocator) Create a WebJarsResourceResolver with a custom WebJarAssetLocator instance, e.g.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	findWebJarResourcePath(java.lang.String path)
protected <any>	resolveResourceInternal(ServerWebExchange exchange, java.lang.String requestPath, java.util.List<? extends Resource> locations, ResourceResolverChain chain)
protected <any>	resolveUrlPathInternal(java.lang.String resourceUrlPath, java.util.List<? extends Resource> locations, ResourceResolverChain chain)

Methods inherited from class org.springframework.web.reactive.resource.AbstractResourceResolver

resolveResource, resolveUrlPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEBJARS_LOCATION

private static final java.lang.String WEBJARS_LOCATION

See Also:

Constant Field Values

WEBJARS_LOCATION_LENGTH

private static final int WEBJARS_LOCATION_LENGTH

webJarAssetLocator

private final WebJarAssetLocator webJarAssetLocator

Constructor Detail

WebJarsResourceResolver

public WebJarsResourceResolver()

Create a WebJarsResourceResolver with a default WebJarAssetLocator instance.

WebJarsResourceResolver

public WebJarsResourceResolver(WebJarAssetLocator webJarAssetLocator)

Create a WebJarsResourceResolver with a custom WebJarAssetLocator instance, e.g. with a custom index.

Method Detail

resolveResourceInternal

protected <any> resolveResourceInternal(@Nullable
                                        ServerWebExchange exchange,
                                        java.lang.String requestPath,
                                        java.util.List<? extends Resource> locations,
                                        ResourceResolverChain chain)

Specified by:

resolveResourceInternal in class AbstractResourceResolver

resolveUrlPathInternal

protected <any> resolveUrlPathInternal(java.lang.String resourceUrlPath,
                                       java.util.List<? extends Resource> locations,
                                       ResourceResolverChain chain)

Specified by:

resolveUrlPathInternal in class AbstractResourceResolver

findWebJarResourcePath

@Nullable
protected java.lang.String findWebJarResourcePath(java.lang.String path)